<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    package org.bukkit.block;<a name="line.1"></a>
<FONT color="green">002</FONT>    <a name="line.2"></a>
<FONT color="green">003</FONT>    import org.bukkit.Chunk;<a name="line.3"></a>
<FONT color="green">004</FONT>    import org.bukkit.Material;<a name="line.4"></a>
<FONT color="green">005</FONT>    import org.bukkit.World;<a name="line.5"></a>
<FONT color="green">006</FONT>    import org.bukkit.material.MaterialData;<a name="line.6"></a>
<FONT color="green">007</FONT>    <a name="line.7"></a>
<FONT color="green">008</FONT>    /**<a name="line.8"></a>
<FONT color="green">009</FONT>     * Represents a captured state of a block, which will not change automatically.<a name="line.9"></a>
<FONT color="green">010</FONT>     *<a name="line.10"></a>
<FONT color="green">011</FONT>     * Unlike Block, which only one object can exist per coordinate, BlockState can<a name="line.11"></a>
<FONT color="green">012</FONT>     * exist multiple times for any given Block. Note that another plugin may change<a name="line.12"></a>
<FONT color="green">013</FONT>     * the state of the block and you will not know, or they may change the block to<a name="line.13"></a>
<FONT color="green">014</FONT>     * another type entirely, causing your BlockState to become invalid.<a name="line.14"></a>
<FONT color="green">015</FONT>     */<a name="line.15"></a>
<FONT color="green">016</FONT>    public interface BlockState {<a name="line.16"></a>
<FONT color="green">017</FONT>    <a name="line.17"></a>
<FONT color="green">018</FONT>        /**<a name="line.18"></a>
<FONT color="green">019</FONT>         * Gets the block represented by this BlockState<a name="line.19"></a>
<FONT color="green">020</FONT>         *<a name="line.20"></a>
<FONT color="green">021</FONT>         * @return Block that this BlockState represents<a name="line.21"></a>
<FONT color="green">022</FONT>         */<a name="line.22"></a>
<FONT color="green">023</FONT>        Block getBlock();<a name="line.23"></a>
<FONT color="green">024</FONT>    <a name="line.24"></a>
<FONT color="green">025</FONT>        /**<a name="line.25"></a>
<FONT color="green">026</FONT>         * Gets the metadata for this block<a name="line.26"></a>
<FONT color="green">027</FONT>         *<a name="line.27"></a>
<FONT color="green">028</FONT>         * @return block specific metadata<a name="line.28"></a>
<FONT color="green">029</FONT>         */<a name="line.29"></a>
<FONT color="green">030</FONT>        MaterialData getData();<a name="line.30"></a>
<FONT color="green">031</FONT>    <a name="line.31"></a>
<FONT color="green">032</FONT>        /**<a name="line.32"></a>
<FONT color="green">033</FONT>         * Gets the type of this block<a name="line.33"></a>
<FONT color="green">034</FONT>         *<a name="line.34"></a>
<FONT color="green">035</FONT>         * @return block type<a name="line.35"></a>
<FONT color="green">036</FONT>         */<a name="line.36"></a>
<FONT color="green">037</FONT>        Material getType();<a name="line.37"></a>
<FONT color="green">038</FONT>    <a name="line.38"></a>
<FONT color="green">039</FONT>        /**<a name="line.39"></a>
<FONT color="green">040</FONT>         * Gets the type-id of this block<a name="line.40"></a>
<FONT color="green">041</FONT>         *<a name="line.41"></a>
<FONT color="green">042</FONT>         * @return block type-id<a name="line.42"></a>
<FONT color="green">043</FONT>         */<a name="line.43"></a>
<FONT color="green">044</FONT>        int getTypeId();<a name="line.44"></a>
<FONT color="green">045</FONT>    <a name="line.45"></a>
<FONT color="green">046</FONT>        /**<a name="line.46"></a>
<FONT color="green">047</FONT>         * Gets the light level between 0-15<a name="line.47"></a>
<FONT color="green">048</FONT>         *<a name="line.48"></a>
<FONT color="green">049</FONT>         * @return light level<a name="line.49"></a>
<FONT color="green">050</FONT>         */<a name="line.50"></a>
<FONT color="green">051</FONT>        byte getLightLevel();<a name="line.51"></a>
<FONT color="green">052</FONT>    <a name="line.52"></a>
<FONT color="green">053</FONT>        /**<a name="line.53"></a>
<FONT color="green">054</FONT>         * Gets the world which contains this Block<a name="line.54"></a>
<FONT color="green">055</FONT>         *<a name="line.55"></a>
<FONT color="green">056</FONT>         * @return World containing this block<a name="line.56"></a>
<FONT color="green">057</FONT>         */<a name="line.57"></a>
<FONT color="green">058</FONT>        World getWorld();<a name="line.58"></a>
<FONT color="green">059</FONT>    <a name="line.59"></a>
<FONT color="green">060</FONT>        /**<a name="line.60"></a>
<FONT color="green">061</FONT>         * Gets the x-coordinate of this block<a name="line.61"></a>
<FONT color="green">062</FONT>         *<a name="line.62"></a>
<FONT color="green">063</FONT>         * @return x-coordinate<a name="line.63"></a>
<FONT color="green">064</FONT>         */<a name="line.64"></a>
<FONT color="green">065</FONT>        int getX();<a name="line.65"></a>
<FONT color="green">066</FONT>    <a name="line.66"></a>
<FONT color="green">067</FONT>        /**<a name="line.67"></a>
<FONT color="green">068</FONT>         * Gets the y-coordinate of this block<a name="line.68"></a>
<FONT color="green">069</FONT>         *<a name="line.69"></a>
<FONT color="green">070</FONT>         * @return y-coordinate<a name="line.70"></a>
<FONT color="green">071</FONT>         */<a name="line.71"></a>
<FONT color="green">072</FONT>        int getY();<a name="line.72"></a>
<FONT color="green">073</FONT>    <a name="line.73"></a>
<FONT color="green">074</FONT>        /**<a name="line.74"></a>
<FONT color="green">075</FONT>         * Gets the z-coordinate of this block<a name="line.75"></a>
<FONT color="green">076</FONT>         *<a name="line.76"></a>
<FONT color="green">077</FONT>         * @return z-coordinate<a name="line.77"></a>
<FONT color="green">078</FONT>         */<a name="line.78"></a>
<FONT color="green">079</FONT>        int getZ();<a name="line.79"></a>
<FONT color="green">080</FONT>    <a name="line.80"></a>
<FONT color="green">081</FONT>        /**<a name="line.81"></a>
<FONT color="green">082</FONT>         * Gets the chunk which contains this block<a name="line.82"></a>
<FONT color="green">083</FONT>         *<a name="line.83"></a>
<FONT color="green">084</FONT>         * @return Containing Chunk<a name="line.84"></a>
<FONT color="green">085</FONT>         */<a name="line.85"></a>
<FONT color="green">086</FONT>        Chunk getChunk();<a name="line.86"></a>
<FONT color="green">087</FONT>    <a name="line.87"></a>
<FONT color="green">088</FONT>        /**<a name="line.88"></a>
<FONT color="green">089</FONT>         * Sets the metadata for this block<a name="line.89"></a>
<FONT color="green">090</FONT>         *<a name="line.90"></a>
<FONT color="green">091</FONT>         * @param data New block specific metadata<a name="line.91"></a>
<FONT color="green">092</FONT>         */<a name="line.92"></a>
<FONT color="green">093</FONT>        void setData(MaterialData data);<a name="line.93"></a>
<FONT color="green">094</FONT>    <a name="line.94"></a>
<FONT color="green">095</FONT>        /**<a name="line.95"></a>
<FONT color="green">096</FONT>         * Sets the type of this block<a name="line.96"></a>
<FONT color="green">097</FONT>         *<a name="line.97"></a>
<FONT color="green">098</FONT>         * @param type Material to change this block to<a name="line.98"></a>
<FONT color="green">099</FONT>         */<a name="line.99"></a>
<FONT color="green">100</FONT>        void setType(Material type);<a name="line.100"></a>
<FONT color="green">101</FONT>    <a name="line.101"></a>
<FONT color="green">102</FONT>        /**<a name="line.102"></a>
<FONT color="green">103</FONT>         * Sets the type-id of this block<a name="line.103"></a>
<FONT color="green">104</FONT>         *<a name="line.104"></a>
<FONT color="green">105</FONT>         * @param type Type-Id to change this block to<a name="line.105"></a>
<FONT color="green">106</FONT>         */<a name="line.106"></a>
<FONT color="green">107</FONT>        boolean setTypeId(int type);<a name="line.107"></a>
<FONT color="green">108</FONT>    <a name="line.108"></a>
<FONT color="green">109</FONT>        /**<a name="line.109"></a>
<FONT color="green">110</FONT>         * Attempts to update the block represented by this state, setting it to the<a name="line.110"></a>
<FONT color="green">111</FONT>         * new values as defined by this state. &lt;br /&gt;<a name="line.111"></a>
<FONT color="green">112</FONT>         * &lt;br /&gt;<a name="line.112"></a>
<FONT color="green">113</FONT>         * This has the same effect as calling update(false). That is to say,<a name="line.113"></a>
<FONT color="green">114</FONT>         * this will not modify the state of a block if it is no longer the same<a name="line.114"></a>
<FONT color="green">115</FONT>         * type as it was when this state was taken. It will return false in this<a name="line.115"></a>
<FONT color="green">116</FONT>         * eventuality.<a name="line.116"></a>
<FONT color="green">117</FONT>         *<a name="line.117"></a>
<FONT color="green">118</FONT>         * @return true if the update was successful, otherwise false<a name="line.118"></a>
<FONT color="green">119</FONT>         * @see BlockState.update(boolean force)<a name="line.119"></a>
<FONT color="green">120</FONT>         */<a name="line.120"></a>
<FONT color="green">121</FONT>        boolean update();<a name="line.121"></a>
<FONT color="green">122</FONT>    <a name="line.122"></a>
<FONT color="green">123</FONT>        /**<a name="line.123"></a>
<FONT color="green">124</FONT>         * Attempts to update the block represented by this state, setting it to the<a name="line.124"></a>
<FONT color="green">125</FONT>         * new values as defined by this state. &lt;br /&gt;<a name="line.125"></a>
<FONT color="green">126</FONT>         * &lt;br /&gt;<a name="line.126"></a>
<FONT color="green">127</FONT>         * Unless force is true, this will not modify the state of a block if it is<a name="line.127"></a>
<FONT color="green">128</FONT>         * no longer the same type as it was when this state was taken. It will return<a name="line.128"></a>
<FONT color="green">129</FONT>         * false in this eventuality.&lt;br /&gt;<a name="line.129"></a>
<FONT color="green">130</FONT>         * &lt;br /&gt;<a name="line.130"></a>
<FONT color="green">131</FONT>         * If force is true, it will set the type of the block to match the new state,<a name="line.131"></a>
<FONT color="green">132</FONT>         * set the state data and then return true.<a name="line.132"></a>
<FONT color="green">133</FONT>         *<a name="line.133"></a>
<FONT color="green">134</FONT>         * @param force true to forcefully set the state<a name="line.134"></a>
<FONT color="green">135</FONT>         * @return true if the update was successful, otherwise false<a name="line.135"></a>
<FONT color="green">136</FONT>         */<a name="line.136"></a>
<FONT color="green">137</FONT>        boolean update(boolean force);<a name="line.137"></a>
<FONT color="green">138</FONT>    <a name="line.138"></a>
<FONT color="green">139</FONT>        public byte getRawData();<a name="line.139"></a>
<FONT color="green">140</FONT>    }<a name="line.140"></a>




























































</PRE>
</BODY>
</HTML>
